home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 July: Mac OS SDK / Dev.CD Jul 99 SDK1.toast / Development Kits / Mac OS / Interfaces&Libraries / Universal / Interfaces / AIncludes / OSA.a < prev    next >
Encoding:
Text File  |  1998-08-17  |  57.5 KB  |  1,830 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        OSA.a
  3. ;
  4. ;    Contains:    AppleScript Client Interfaces.
  5. ;
  6. ;    Version:    Technology:    AppleScript 1.1
  7. ;                Release:    Universal Interfaces 3.2
  8. ;
  9. ;    Copyright:    © 1992-1998 by Apple Computer, Inc., all rights reserved
  10. ;
  11. ;    Bugs?:        For bug reports, consult the following page on
  12. ;                the World Wide Web:
  13. ;
  14. ;                    http://developer.apple.com/bugreporter/
  15. ;
  16. ;
  17.     IF &TYPE('__OSA__') = 'UNDEFINED' THEN
  18. __OSA__ SET 1
  19.  
  20.     IF &TYPE('__ERRORS__') = 'UNDEFINED' THEN
  21.     include 'Errors.a'
  22.     ENDIF
  23.     IF &TYPE('__APPLEEVENTS__') = 'UNDEFINED' THEN
  24.     include 'AppleEvents.a'
  25.     ENDIF
  26.     IF &TYPE('__AEOBJECTS__') = 'UNDEFINED' THEN
  27.     include 'AEObjects.a'
  28.     ENDIF
  29.     IF &TYPE('__COMPONENTS__') = 'UNDEFINED' THEN
  30.     include 'Components.a'
  31.     ENDIF
  32.  
  33. ; **************************************************************************
  34. ;    Types and Constants
  35. ;*************************************************************************
  36.  
  37.  
  38. ;     The componenent manager type code for components that
  39. ;        support the OSA interface defined here. 
  40. ;  0x6f736120 
  41.  
  42. kOSAComponentType                EQU        'osa '
  43. ;  0x73637074 
  44.  
  45. kOSAGenericScriptingComponentSubtype EQU 'scpt'
  46. ;     Type of script document files.    
  47. ;  0x6f736173 
  48.  
  49. kOSAFileType                    EQU        'osas'
  50. ; 
  51. ;        Suite and event code of the RecordedText event. 
  52. ;        (See OSAStartRecording, below.)
  53. ;    
  54.  
  55. ;  0x61736372 
  56.  
  57. kOSASuite                        EQU        'ascr'
  58. ;  0x72656364 
  59.  
  60. kOSARecordedText                EQU        'recd'
  61. ;  Selector returns boolean 
  62. ;  0x6d6f6469 
  63.  
  64. kOSAScriptIsModified            EQU        'modi'
  65. ;  Selector returns boolean 
  66. ;  0x63736372 
  67.  
  68. kOSAScriptIsTypeCompiledScript    EQU        'cscr'
  69. ;  Selector returns boolean 
  70. ;  0x76616c75 
  71.  
  72. kOSAScriptIsTypeScriptValue        EQU        'valu'
  73. ;  Selector returns boolean 
  74. ;  0x636e7478 
  75.  
  76. kOSAScriptIsTypeScriptContext    EQU        'cntx'
  77. ;  Selector returns a DescType which may be passed to OSACoerceToDesc 
  78. ;  0x62657374 
  79.  
  80. kOSAScriptBestType                EQU        'best'
  81. ; 
  82. ;        This selector is used to determine whether a script has source 
  83. ;        associated with it that when given to OSAGetSource, the call will not
  84. ;        fail.  The selector returns a boolean.
  85. ;    
  86.  
  87. ;  0x67737263 
  88.  
  89. kOSACanGetSource                EQU        'gsrc'
  90.  
  91.  
  92. typeOSADialectInfo                EQU        'difo'                ;  0x6469666f   
  93. keyOSADialectName                EQU        'dnam'                ;  0x646e616d   
  94. keyOSADialectCode                EQU        'dcod'                ;  0x64636f64   
  95. keyOSADialectLangCode            EQU        'dlcd'                ;  0x646c6364   
  96. keyOSADialectScriptCode            EQU        'dscd'                ;  0x64736364   
  97. ; typedef ComponentResult                 OSAError
  98.  
  99. ;  Under the Open Scripting Architecture all error results are longs 
  100. ; typedef unsigned long                 OSAID
  101.  
  102. ; 
  103. ;        OSAIDs allow transparent manipulation of scripts associated with
  104. ;         various scripting systems.
  105. ;    
  106.  
  107.  
  108. kOSANullScript                    EQU        0
  109. ;  No -script constant. 
  110.  
  111. kOSANullMode                    EQU        0                    ; sounds better 
  112. kOSAModeNull                    EQU        0                    ; tastes consistent 
  113. ; 
  114. ;        Some routines take flags that control their execution.  This constant
  115. ;        declares default mode settings are used.
  116. ;    
  117.  
  118. ; **************************************************************************
  119. ;    Standard Script Errors
  120. ;**************************************************************************
  121. ;    It is recommended that scripting components use the following set of error
  122. ;    codes to signal failure when applicable.  This enables applications that
  123. ;    use the OSA API to deal with some class of script errors in a less than 
  124. ;    ad hoc manner.  Scripting components are of course encouraged to return
  125. ;    component-specific errors when these don't apply.
  126. ;*************************************************************************
  127.  
  128. ;         Dynamic errors:
  129. ;
  130. ;    These errors result from data-dependent conditions and are typically
  131. ;    signaled at runtime.
  132. ;
  133.  
  134. ; 
  135. ;        Signaled when a value can't be coerced to the desired type. Similar
  136. ;          to errOSATypeError except results from coercion.
  137. ;    
  138.  
  139.  
  140. errOSACantCoerce                EQU        -1700
  141. ;  Signaled when an object is not found in a container 
  142.  
  143. errOSACantAccess                EQU        -1728
  144. ; 
  145. ;        Signaled when an object cannot be set in a container.  Same as 
  146. ;          AERegistry error errAEWriteDenied.
  147. ;    
  148.  
  149.  
  150. errOSACantAssign                EQU        -10006
  151. ; 
  152. ;        Signaled by user scripts or applications when no actual error code
  153. ;          is to be returned.  Simply means "an error has occurred".  Most useful
  154. ;          in conjunction with an error message from the application.
  155. ;    
  156.  
  157.  
  158. errOSAGeneralError                EQU        -2700
  159. ;  Signaled when there is an attempt to divide by zero 
  160.  
  161. errOSADivideByZero                EQU        -2701
  162. ;  Signaled when integer or real value is too large to be represented 
  163.  
  164. errOSANumericOverflow            EQU        -2702
  165. ; 
  166. ;        Signaled when application can't be launched or when it is remote and
  167. ;          program linking is not enabled.
  168. ;    
  169.  
  170.  
  171. errOSACantLaunch                EQU        -2703
  172. ;  Signaled when an application can't respond to AppleEvents 
  173.  
  174. errOSAAppNotHighLevelEventAware    EQU        -2704
  175. ;  Signaled when an application's terminology resource is not readable 
  176.  
  177. errOSACorruptTerminology        EQU        -2705
  178. ;  Signaled when the runtime stack overflows 
  179.  
  180. errOSAStackOverflow                EQU        -2706
  181. ;  Signaled when a runtime internal data structure overflows 
  182.  
  183. errOSAInternalTableOverflow        EQU        -2707
  184. ; 
  185. ;        Signaled when an intrinsic limitation is exceeded for the size of 
  186. ;          a value or data structure.
  187. ;    
  188.  
  189.  
  190. errOSADataBlockTooLarge            EQU        -2708
  191.  
  192. errOSACantGetTerminology        EQU        -2709
  193.  
  194. errOSACantCreate                EQU        -2710
  195. ;         Component-specific dynamic script errors:
  196. ;
  197. ;    The range -2720 thru -2739 is reserved for component-specific runtime errors.
  198. ;    (Note that error codes from different scripting components in this range will
  199. ;    overlap.)
  200. ;
  201.  
  202. ;         Static errors:
  203. ;
  204. ;    These errors comprise what are commonly thought of as parse and compile-
  205. ;    time errors.  However, in a dynamic system (e.g. AppleScript) any or all
  206. ;    of these may also occur at runtime.
  207. ;
  208.  
  209.  
  210. ;  Signaled when data was not the right type and coercion is not allowed 
  211.  
  212. errOSATypeError                    EQU        -1703
  213. ;  Signaled when a message was sent to an object that didn't handle it 
  214.  
  215. OSAMessageNotUnderstood            EQU        -1708
  216. ; 
  217. ;        Signaled when a function to be returned doesn't exist.  (Probably only
  218. ;          useful in languages with first-class functions that distinguish between
  219. ;          functions and other values (two name spaces). This is different from
  220. ;          errOSAMessageNotUnderstood, which may be signaled when the method is
  221. ;          invoked.
  222. ;    
  223.  
  224.  
  225. OSAUndefinedHandler                EQU        -1717
  226. ;  Signaled when a container can never have the requested object 
  227.  
  228. OSAIllegalAccess                EQU        -1723
  229. ;  Signaled when index was out of range. Specialization of errOSACantAccess. 
  230.  
  231. OSAIllegalIndex                    EQU        -1719
  232. ;  Signaled when a range is screwy. Specialization of errOSACantAccess. 
  233.  
  234. OSAIllegalRange                    EQU        -1720
  235. ; 
  236. ;        Signaled when an object can never be set in a container.  Same as 
  237. ;          AERegistry error errAENotModifiable.
  238. ;    
  239.  
  240.  
  241. OSAIllegalAssign                EQU        -10003
  242. ; 
  243. ;        Signaled when a syntax error occurs. (e.g. "Syntax error" or
  244. ;         "<this> can't go after <that>").
  245. ;    
  246.  
  247.  
  248. OSASyntaxError                    EQU        -2740
  249. ; 
  250. ;        Signaled when another form of syntax was expected. (e.g. "expected
  251. ;          a <type> but found <this>").
  252. ;    
  253.  
  254.  
  255. OSASyntaxTypeError                EQU        -2741
  256. ;  Signaled when a name or number is too long to be parsed 
  257.  
  258. OSATokenTooLong                    EQU        -2742
  259. ; 
  260. ;        Signaled when a parameter is missing for a function invocation.  Note
  261. ;          that in some languages, this error may occur at runtime.
  262. ;    
  263.  
  264.  
  265. OSAMissingParameter                EQU        -1701
  266. ; 
  267. ;        Signaled when function is called with the wrong number of parameters,
  268. ;          or a parameter pattern cannot be matched.
  269. ;    
  270.  
  271.  
  272. OSAParameterMismatch            EQU        -1721
  273. ; 
  274. ;        Signaled when a formal parameter, local variable, or instance variable
  275. ;          is specified more than once.
  276. ;    
  277.  
  278.  
  279. OSADuplicateParameter            EQU        -2750
  280. ; 
  281. ;        Signaled when a formal parameter, local variable, or instance variable
  282. ;          is specified more than once.
  283. ;    
  284.  
  285.  
  286. OSADuplicateProperty            EQU        -2751
  287. ; 
  288. ;        Signaled when more than one handler is defined with the same name in 
  289. ;          a scope where the language doesn't allow it.
  290. ;    
  291.  
  292.  
  293. OSADuplicateHandler                EQU        -2752
  294. ;  Signaled when a variable is accessed that has no value 
  295.  
  296. OSAUndefinedVariable            EQU        -2753
  297. ; 
  298. ;        Signaled when a variable is declared inconsistently in the same scope,
  299. ;          such as both local and global.
  300. ;    
  301.  
  302.  
  303. OSAInconsistentDeclarations        EQU        -2754
  304. ; 
  305. ;        Signaled when illegal control flow occurs in an application (no catcher
  306. ;          for throw, non-lexical loop exit, etc.).
  307. ;    
  308.  
  309.  
  310. OSAControlFlowError                EQU        -2755
  311. ;         Component-specific static script errors:
  312. ;
  313. ;    The range -2760 thru -2779 is reserved for component-specific parsing and
  314. ;    compile-time errors. (Note that error codes from different scripting
  315. ;    components in this range will overlap.)
  316. ;
  317.  
  318. ;         Dialect-specific script errors:
  319. ;
  320. ;    The range -2780 thru -2799 is reserved for dialect specific error codes for
  321. ;    scripting components that support dialects. (Note that error codes from
  322. ;    different scripting components in this range will overlap, as well as error
  323. ;    codes from different dialects in the same scripting component.)
  324. ;
  325.  
  326. ; **************************************************************************
  327. ;    OSA Interface Descriptions
  328. ;**************************************************************************
  329. ;    The OSA Interface is broken down into a required interface, and several
  330. ;    optional interfaces to support additional functionality.  A given scripting
  331. ;    component may choose to support only some of the optional interfaces in
  332. ;    addition to the basic interface.  The OSA Component Flags may be used to 
  333. ;    query the Component Manager to find a scripting component with a particular
  334. ;    capability, or determine if a particular scripting component supports a 
  335. ;    particular capability.
  336. ;*************************************************************************
  337.  
  338. ;  OSA Component Flags: 
  339.  
  340. kOSASupportsCompiling            EQU        $0002
  341. kOSASupportsGetSource            EQU        $0004
  342. kOSASupportsAECoercion            EQU        $0008
  343. kOSASupportsAESending            EQU        $0010
  344. kOSASupportsRecording            EQU        $0020
  345. kOSASupportsConvenience            EQU        $0040
  346. kOSASupportsDialects            EQU        $0080
  347. kOSASupportsEventHandling        EQU        $0100
  348. ;  Component Selectors: 
  349.  
  350. kOSASelectLoad                    EQU        $0001
  351. kOSASelectStore                    EQU        $0002
  352. kOSASelectExecute                EQU        $0003
  353. kOSASelectDisplay                EQU        $0004
  354. kOSASelectScriptError            EQU        $0005
  355. kOSASelectDispose                EQU        $0006
  356. kOSASelectSetScriptInfo            EQU        $0007
  357. kOSASelectGetScriptInfo            EQU        $0008
  358. kOSASelectSetActiveProc            EQU        $0009
  359. kOSASelectGetActiveProc            EQU        $000A
  360. ;  Compiling: 
  361.  
  362. kOSASelectScriptingComponentName EQU    $0102
  363. kOSASelectCompile                EQU        $0103
  364. kOSASelectCopyID                EQU        $0104
  365. ;  GetSource: 
  366.  
  367. kOSASelectGetSource                EQU        $0201
  368. ;  AECoercion: 
  369.  
  370. kOSASelectCoerceFromDesc        EQU        $0301
  371. kOSASelectCoerceToDesc            EQU        $0302
  372. ;  AESending: 
  373.  
  374. kOSASelectSetSendProc            EQU        $0401
  375. kOSASelectGetSendProc            EQU        $0402
  376. kOSASelectSetCreateProc            EQU        $0403
  377. kOSASelectGetCreateProc            EQU        $0404
  378. kOSASelectSetDefaultTarget        EQU        $0405
  379. ;  Recording: 
  380.  
  381. kOSASelectStartRecording        EQU        $0501
  382. kOSASelectStopRecording            EQU        $0502
  383. ;  Convenience: 
  384.  
  385. kOSASelectLoadExecute            EQU        $0601
  386. kOSASelectCompileExecute        EQU        $0602
  387. kOSASelectDoScript                EQU        $0603
  388. ;  Dialects: 
  389.  
  390. kOSASelectSetCurrentDialect        EQU        $0701
  391. kOSASelectGetCurrentDialect        EQU        $0702
  392. kOSASelectAvailableDialects        EQU        $0703
  393. kOSASelectGetDialectInfo        EQU        $0704
  394. kOSASelectAvailableDialectCodeList EQU    $0705
  395. ;  Event Handling: 
  396.  
  397. kOSASelectSetResumeDispatchProc    EQU        $0801
  398. kOSASelectGetResumeDispatchProc    EQU        $0802
  399. kOSASelectExecuteEvent            EQU        $0803
  400. kOSASelectDoEvent                EQU        $0804
  401. kOSASelectMakeContext            EQU        $0805
  402.  
  403. ;  scripting component specific selectors are added beginning with this value  
  404.  
  405. kOSASelectComponentSpecificStart EQU    $1001
  406.  
  407. ;         Mode Flags:
  408. ;
  409. ;    Warning: These should not conflict with the AESend mode flags in
  410. ;    AppleEvents.h, because we may want to use them as OSA mode flags too.
  411. ;
  412.  
  413.  
  414. ; 
  415. ;        This mode flag may be passed to OSALoad, OSAStore or OSACompile to
  416. ;          instruct the scripting component to not retain the "source" of an
  417. ;          expression.  This will cause the OSAGetSource call to return the error
  418. ;          errOSASourceNotAvailable if used.  However, some scripting components
  419. ;          may not retain the source anyway.  This is mainly used when either space
  420. ;          efficiency is desired, or a script is to be "locked" so that its
  421. ;          implementation may not be viewed.
  422. ;    
  423.  
  424.  
  425. kOSAModePreventGetSource        EQU        $00000001
  426. ; 
  427. ;        These mode flags may be passed to OSACompile, OSAExecute, OSALoadExecute
  428. ;          OSACompileExecute, OSADoScript, OSAExecuteEvent, or OSADoEvent to
  429. ;          indicate whether or not the script may interact with the user, switch
  430. ;          layer or reconnect if necessary.  Any AppleEvents will be sent with the
  431. ;          corresponding AESend mode supplied.
  432. ;    
  433.  
  434.  
  435. kOSAModeNeverInteract            EQU        $00000010
  436. kOSAModeCanInteract                EQU        $00000020
  437. kOSAModeAlwaysInteract            EQU        $00000030
  438. kOSAModeDontReconnect            EQU        $00000080
  439. ; 
  440. ;        This mode flag may be passed to OSACompile, OSAExecute, OSALoadExecute
  441. ;          OSACompileExecute, OSADoScript, OSAExecuteEvent, or OSADoEvent to
  442. ;          indicate whether or not AppleEvents should be sent with the
  443. ;          kAECanSwitchLayer mode flag sent or not. NOTE: This flag is exactly the
  444. ;          opposite sense of the AppleEvent flag kAECanSwitchLayer.  This is to
  445. ;          provide a more convenient default, i.e. not supplying any mode
  446. ;          (kOSAModeNull) means to send events with kAECanSwitchLayer.  Supplying
  447. ;          the kOSAModeCantSwitchLayer mode flag will cause AESend to be called
  448. ;          without kAECanSwitchLayer.
  449. ;    
  450.  
  451.  
  452. kOSAModeCantSwitchLayer            EQU        $00000040
  453. ; 
  454. ;        This mode flag may be passed to OSACompile, OSAExecute, OSALoadExecute
  455. ;          OSACompileExecute, OSADoScript, OSAExecuteEvent, or OSADoEvent to
  456. ;          indicate whether or not AppleEvents should be sent with the kAEDontRecord
  457. ;          mode flag sent or not. NOTE: This flag is exactly the opposite sense of
  458. ;          the AppleEvent flag kAEDontRecord.  This is to provide a more convenient
  459. ;          default, i.e. not supplying any mode (kOSAModeNull) means to send events
  460. ;          with kAEDontRecord.  Supplying the kOSAModeDoRecord mode flag will 
  461. ;          cause AESend to be called without kAEDontRecord.
  462. ;    
  463.  
  464.  
  465. kOSAModeDoRecord                EQU        $00001000
  466. ; 
  467. ;        This is a mode flag for OSACompile that indicates that a context should
  468. ;          be created as the result of compilation. All handler definitions are
  469. ;          inserted into the new context, and variables are initialized by
  470. ;          evaluating their initial values in a null context (i.e. they must be
  471. ;          constant expressions).
  472. ;    
  473.  
  474.  
  475. kOSAModeCompileIntoContext        EQU        $00000002
  476. ; 
  477. ;        This is a mode flag for OSACompile that indicates that the previous
  478. ;          script ID (input to OSACompile) should be augmented with any new
  479. ;          definitions in the sourceData rather than replaced with a new script.
  480. ;          This means that the previous script ID must designate a context.
  481. ;          The presence of this flag causes the kOSAModeCompileIntoContext flag
  482. ;          to be implicitly used, causing any new definitions to be initialized
  483. ;          in a null context.
  484. ;    
  485.  
  486.  
  487. kOSAModeAugmentContext            EQU        $00000004
  488. ; 
  489. ;        This mode flag may be passed to OSADisplay or OSADoScript to indicate
  490. ;          that output only need be human-readable, not re-compilable by OSACompile.
  491. ;          If used, output may be arbitrarily "beautified", e.g. quotes may be left
  492. ;          off of string values, long lists may have elipses, etc.
  493. ;    
  494.  
  495.  
  496. kOSAModeDisplayForHumans        EQU        $00000008
  497. ; 
  498. ;        This mode flag may be passed to OSAStore in the case where the scriptID
  499. ;          is a context.  This causes the context to be saved, but not the context's
  500. ;          parent context.  When the stored context is loaded back in, the parent
  501. ;          will be kOSANullScript.
  502. ;    
  503.  
  504.  
  505. kOSAModeDontStoreParent            EQU        $00010000
  506. ; 
  507. ;        This mode flag may be passed to OSAExecuteEvent to cause the event to
  508. ;          be dispatched to the direct object of the event. The direct object (or
  509. ;          subject attribute if the direct object is a non-object specifier) will
  510. ;          be resolved, and the resulting script object will be the recipient of
  511. ;          the message. The context argument to OSAExecuteEvent will serve as the
  512. ;          root of the lookup/resolution process.
  513. ;    
  514.  
  515.  
  516. kOSAModeDispatchToDirectObject    EQU        $00020000
  517. ; 
  518. ;        This mode flag may be passed to OSAExecuteEvent to indicate that
  519. ;          components do not have to get the data of object specifier arguments.
  520. ;    
  521.  
  522.  
  523. kOSAModeDontGetDataForArguments    EQU        $00040000
  524. ; **************************************************************************
  525. ;    OSA Basic Scripting Interface
  526. ;**************************************************************************
  527. ;    Scripting components must at least support the Basic Scripting interface.
  528. ;*************************************************************************
  529.  
  530. ;         Loading and Storing Scripts:
  531. ;
  532. ;    These routines allow scripts to be loaded and stored in their internal
  533. ;    (possibly compiled, non-text) representation.
  534. ;
  535.  
  536.  
  537. ;  Resource type for scripts 
  538.  
  539. kOSAScriptResourceType            EQU        'scpt'
  540. ; 
  541. ;        Default type given to OSAStore which creates "generic" loadable script
  542. ;          data descriptors.
  543. ;    
  544.  
  545.  
  546. typeOSAGenericStorage            EQU        'scpt'
  547. ;
  548. ; pascal OSAError OSALoad(ComponentInstance scriptingComponent, const AEDesc *scriptData, long modeFlags, OSAID *resultingScriptID)
  549. ;
  550.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  551.         Macro
  552.         _OSALoad
  553.             move.l              #$000C0001,-(sp)
  554.             moveq               #0,D0
  555.             dc.w                $A82A
  556.         EndM
  557.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  558.         IMPORT_CFM_FUNCTION OSALoad
  559.     ENDIF
  560.  
  561. ; 
  562. ;        OSAComponentFunctionInline(kOSASelectLoad, 12);
  563. ;    
  564. ;        Errors:
  565. ;            badComponentInstance        invalid scripting component instance
  566. ;            errOSASystemError
  567. ;            errOSABadStorageType:        scriptData not for this scripting component
  568. ;            errOSACorruptData:            data seems to be corrupt
  569. ;            errOSADataFormatObsolete    script data format is no longer supported
  570. ;            errOSADataFormatTooNew        script data format is from a newer version
  571. ;        
  572. ;        ModeFlags:
  573. ;            kOSAModePreventGetSource
  574. ;    
  575.  
  576. ;
  577. ; pascal OSAError OSAStore(ComponentInstance scriptingComponent, OSAID scriptID, DescType desiredType, long modeFlags, AEDesc *resultingScriptData)
  578. ;
  579.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  580.         Macro
  581.         _OSAStore
  582.             move.l              #$00100002,-(sp)
  583.             moveq               #0,D0
  584.             dc.w                $A82A
  585.         EndM
  586.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  587.         IMPORT_CFM_FUNCTION OSAStore
  588.     ENDIF
  589.  
  590. ; 
  591. ;        OSAComponentFunctionInline(kOSASelectStore, 16);
  592. ;    
  593. ;        Errors:
  594. ;            badComponentInstance    invalid scripting component instance
  595. ;            errOSASystemError
  596. ;            errOSAInvalidID
  597. ;            errOSABadStorageType:    desiredType not for this scripting component
  598. ;        
  599. ;        ModeFlags:
  600. ;            kOSAModePreventGetSource
  601. ;            kOSAModeDontStoreParent
  602. ;    
  603.  
  604. ;  Executing Scripts: 
  605. ;
  606. ; pascal OSAError OSAExecute(ComponentInstance scriptingComponent, OSAID compiledScriptID, OSAID contextID, long modeFlags, OSAID *resultingScriptValueID)
  607. ;
  608.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  609.         Macro
  610.         _OSAExecute
  611.             move.l              #$00100003,-(sp)
  612.             moveq               #0,D0
  613.             dc.w                $A82A
  614.         EndM
  615.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  616.         IMPORT_CFM_FUNCTION OSAExecute
  617.     ENDIF
  618.  
  619. ; 
  620. ;        OSAComponentFunctionInline(kOSASelectExecute, 16);
  621. ;        This call runs a script.  The contextID represents the environment
  622. ;        with which global variables in the script are resolved.  The constant
  623. ;        kOSANullScript may be used for the contextID if the application wishes
  624. ;        to not deal with context directly (a default one is associated with each
  625. ;        scripting component instance).  The resultingScriptValueID is the 
  626. ;        result of evaluation, and contains a value which may be displayed using
  627. ;        the OSAGetSource call.  The modeFlags convey scripting component
  628. ;        specific information.
  629. ;    
  630. ;        Errors:
  631. ;            badComponentInstance    invalid scripting component instance
  632. ;            errOSASystemError
  633. ;            errOSAInvalidID
  634. ;            errOSAScriptError:        the executing script got an error
  635. ;    
  636. ;        ModeFlags:
  637. ;            kOSAModeNeverInteract
  638. ;            kOSAModeCanInteract
  639. ;            kOSAModeAlwaysInteract
  640. ;            kOSAModeCantSwitchLayer
  641. ;            kOSAModeDontReconnect
  642. ;            kOSAModeDoRecord
  643. ;    
  644.  
  645. ;  Displaying results: 
  646. ;
  647. ; pascal OSAError OSADisplay(ComponentInstance scriptingComponent, OSAID scriptValueID, DescType desiredType, long modeFlags, AEDesc *resultingText)
  648. ;
  649.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  650.         Macro
  651.         _OSADisplay
  652.             move.l              #$00100004,-(sp)
  653.             moveq               #0,D0
  654.             dc.w                $A82A
  655.         EndM
  656.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  657.         IMPORT_CFM_FUNCTION OSADisplay
  658.     ENDIF
  659.  
  660. ; 
  661. ;        OSAComponentFunctionInline(kOSASelectDisplay, 16);
  662. ;        This call is used to convert results (script value IDs) into displayable
  663. ;        text. The desiredType should be at least typeChar, and modeFlags are
  664. ;        scripting system specific flags to control the formatting of the
  665. ;        resulting text. This call differs from OSAGetSource in that (1) it
  666. ;        always produces at least typeChar, (2) is only works on script values,
  667. ;        (3) it may display it's output in non-compilable form (e.g. without
  668. ;        string quotes, elipses inserted in long and/or circular lists, etc.) and
  669. ;        (4) it is required by the basic scripting interface.
  670. ;    
  671. ;        Errors:
  672. ;            badComponentInstance    invalid scripting component instance
  673. ;            errOSASystemError
  674. ;            errOSAInvalidID
  675. ;            errAECoercionFail:        desiredType not supported by scripting component
  676. ;    
  677. ;        ModeFlags:
  678. ;            kOSAModeDisplayForHumans
  679. ;    
  680.  
  681. ;  Getting Error Information: 
  682. ;
  683. ; pascal OSAError OSAScriptError(ComponentInstance scriptingComponent, OSType selector, DescType desiredType, AEDesc *resultingErrorDescription)
  684. ;
  685.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  686.         Macro
  687.         _OSAScriptError
  688.             move.l              #$000C0005,-(sp)
  689.             moveq               #0,D0
  690.             dc.w                $A82A
  691.         EndM
  692.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  693.         IMPORT_CFM_FUNCTION OSAScriptError
  694.     ENDIF
  695.  
  696. ; 
  697. ;        OSAComponentFunctionInline(kOSASelectScriptError, 12);
  698. ;        Whenever script execution returns errOSAExecutionError, this routine
  699. ;        may be used to get information about that error.  The selector describes
  700. ;        the type of information desired about the error (various selectors are
  701. ;        listed below).  The desiredType indicates the data type of the result
  702. ;        desired for that selector.
  703. ;    
  704. ;        Errors:
  705. ;            badComponentInstance    invalid scripting component instance
  706. ;            errOSASystemError
  707. ;            errOSABadSelector:        selector not supported by scripting component
  708. ;            errAECoercionFail:        desiredType not supported by scripting component
  709. ;    
  710.  
  711. ;  OSAScriptError selectors: 
  712. ; 
  713. ;        This selector is used to determine the error number of a script error.
  714. ;        These error numbers may be either system error numbers, or error numbers
  715. ;        that are scripting component specific.
  716. ;        Required desiredTypes:    
  717. ;              typeShortInteger
  718. ;    
  719.  
  720.  
  721. kOSAErrorNumber                    EQU        'errn'
  722. ; 
  723. ;        This selector is used to determine the full error message associated
  724. ;        with the error number.  It should include the name of the application
  725. ;        which caused the error, as well as the specific error that occurred.
  726. ;        This selector is sufficient for simple error reporting (but see
  727. ;        kOSAErrorBriefMessage, below).
  728. ;        Required desiredTypes:
  729. ;            typeChar                    error message string
  730. ;    
  731.  
  732.  
  733. kOSAErrorMessage                EQU        'errs'
  734. ; 
  735. ;        This selector is used to determine a brief error message associated with
  736. ;        the error number.  This message and should not mention the name of the
  737. ;        application which caused the error, any partial results or offending
  738. ;        object (see kOSAErrorApp, kOSAErrorPartialResult and
  739. ;        kOSAErrorOffendingObject, below).
  740. ;        Required desiredTypes:
  741. ;              typeChar                    brief error message string
  742. ;    
  743.  
  744. ;   0x65727262  
  745.  
  746. kOSAErrorBriefMessage            EQU        'errb'
  747. ; 
  748. ;        This selector is used to determine which application actually got the
  749. ;        error (if it was the result of an AESend), or the current application
  750. ;        if ....
  751. ;        Required desiredTypes:
  752. ;              typeProcessSerialNumber        PSN of the errant application
  753. ;              typeChar                    name of the errant application
  754. ;    
  755.  
  756. ;   0x65726170  
  757.  
  758. kOSAErrorApp                    EQU        'erap'
  759. ; 
  760. ;        This selector is used to determine any partial result returned by an 
  761. ;        operation. If an AESend call failed, but a partial result was returned,
  762. ;        then the partial result may be returned as an AEDesc.
  763. ;        Required desiredTypes:
  764. ;              typeBest                    AEDesc of any partial result
  765. ;    
  766.  
  767. ;   0x70746c72   
  768.  
  769. kOSAErrorPartialResult            EQU        'ptlr'
  770. ; 
  771. ;        This selector is used to determine any object which caused the error
  772. ;        that may have been indicated by an application.  The result is an 
  773. ;        AEDesc.
  774. ;        Required desiredTypes:
  775. ;              typeBest                    AEDesc of any offending object
  776. ;    
  777.  
  778. ;   0x65726f62   
  779.  
  780. kOSAErrorOffendingObject        EQU        'erob'
  781. ; 
  782. ;        This selector is used to determine the type expected by a coercion 
  783. ;        operation if a type error occurred.
  784. ;    
  785.  
  786. ;   0x65727274   
  787.  
  788. kOSAErrorExpectedType            EQU        'errt'
  789. ; 
  790. ;        This selector is used to determine the source text range (start and 
  791. ;        end positions) of where the error occurred.
  792. ;        Required desiredTypes:
  793. ;              typeOSAErrorRange
  794. ;    
  795.  
  796. ;   0x65726e67  
  797.  
  798. kOSAErrorRange                    EQU        'erng'
  799. ; 
  800. ;        An AERecord type containing keyOSASourceStart and keyOSASourceEnd fields
  801. ;        of type short.
  802. ;    
  803.  
  804. ;   0x65726e67   
  805.  
  806. typeOSAErrorRange                EQU        'erng'
  807. ;  Field of a typeOSAErrorRange record of typeShortInteger 
  808. ;   0x73726373    
  809.  
  810. keyOSASourceStart                EQU        'srcs'
  811. ;  Field of a typeOSAErrorRange record of typeShortInteger 
  812. ;   0x73726365   
  813.  
  814. keyOSASourceEnd                    EQU        'srce'
  815. ;  Disposing Script IDs: 
  816. ;
  817. ; pascal OSAError OSADispose(ComponentInstance scriptingComponent, OSAID scriptID)
  818. ;
  819.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  820.         Macro
  821.         _OSADispose
  822.             move.l              #$00040006,-(sp)
  823.             moveq               #0,D0
  824.             dc.w                $A82A
  825.         EndM
  826.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  827.         IMPORT_CFM_FUNCTION OSADispose
  828.     ENDIF
  829.  
  830. ; 
  831. ;        OSAComponentFunctionInline(kOSASelectDispose, 4);
  832. ;        Disposes a script or context.
  833. ;    
  834. ;        Errors:
  835. ;            badComponentInstance    invalid scripting component instance
  836. ;            errOSASystemError
  837. ;            errOSAInvalidID
  838. ;    
  839.  
  840. ;  Getting and Setting Script Information: 
  841. ;
  842. ; pascal OSAError OSASetScriptInfo(ComponentInstance scriptingComponent, OSAID scriptID, OSType selector, long value)
  843. ;
  844.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  845.         Macro
  846.         _OSASetScriptInfo
  847.             move.l              #$000C0007,-(sp)
  848.             moveq               #0,D0
  849.             dc.w                $A82A
  850.         EndM
  851.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  852.         IMPORT_CFM_FUNCTION OSASetScriptInfo
  853.     ENDIF
  854.  
  855. ; 
  856. ;        OSAComponentFunctionInline(kOSASelectSetScriptInfo, 12);
  857. ;    
  858. ;        Errors:
  859. ;            badComponentInstance    invalid scripting component instance
  860. ;            errOSASystemError
  861. ;            errOSAInvalidID
  862. ;            errOSABadSelector:        selector not supported by scripting component
  863. ;                                    or selector not for this scriptID
  864. ;    
  865.  
  866. ;
  867. ; pascal OSAError OSAGetScriptInfo(ComponentInstance scriptingComponent, OSAID scriptID, OSType selector, long *result)
  868. ;
  869.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  870.         Macro
  871.         _OSAGetScriptInfo
  872.             move.l              #$000C0008,-(sp)
  873.             moveq               #0,D0
  874.             dc.w                $A82A
  875.         EndM
  876.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  877.         IMPORT_CFM_FUNCTION OSAGetScriptInfo
  878.     ENDIF
  879.  
  880. ; 
  881. ;        OSAComponentFunctionInline(kOSASelectGetScriptInfo, 12);
  882. ;    
  883. ;        Errors:
  884. ;            badComponentInstance    invalid scripting component instance
  885. ;            errOSASystemError
  886. ;            errOSAInvalidID
  887. ;            errOSABadSelector:        selector not supported by scripting component
  888. ;                                    or selector not for this scriptID
  889. ;    
  890.  
  891. ;  Manipulating the ActiveProc:
  892. ;
  893. ;    Scripting systems will supply default values for these procedures if they
  894. ;    are not set by the client:
  895. ;
  896.  
  897. ;
  898. ; pascal OSAError OSASetActiveProc(ComponentInstance scriptingComponent, OSAActiveUPP activeProc, long refCon)
  899. ;
  900.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  901.         Macro
  902.         _OSASetActiveProc
  903.             move.l              #$00080009,-(sp)
  904.             moveq               #0,D0
  905.             dc.w                $A82A
  906.         EndM
  907.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  908.         IMPORT_CFM_FUNCTION OSASetActiveProc
  909.     ENDIF
  910.  
  911. ; 
  912. ;        OSAComponentFunctionInline(kOSASelectSetActiveProc, 8);
  913. ;        If activeProc is nil, the default activeProc is used.
  914. ;    
  915. ;        Errors:
  916. ;            badComponentInstance    invalid scripting component instance
  917. ;            errOSASystemError
  918. ;    
  919.  
  920. ;
  921. ; pascal OSAError OSAGetActiveProc(ComponentInstance scriptingComponent, OSAActiveUPP *activeProc, long *refCon)
  922. ;
  923.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  924.         Macro
  925.         _OSAGetActiveProc
  926.             move.l              #$0008000A,-(sp)
  927.             moveq               #0,D0
  928.             dc.w                $A82A
  929.         EndM
  930.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  931.         IMPORT_CFM_FUNCTION OSAGetActiveProc
  932.     ENDIF
  933.  
  934. ; 
  935. ;        OSAComponentFunctionInline(kOSASelectGetActiveProc, 8);
  936. ;    
  937. ;        Errors:
  938. ;            badComponentInstance    invalid scripting component instance
  939. ;            errOSASystemError
  940. ;    
  941.  
  942. ; **************************************************************************
  943. ;    OSA Optional Compiling Interface
  944. ;**************************************************************************
  945. ;    Scripting components that support the Compiling interface have the 
  946. ;    kOSASupportsCompiling bit set in it's ComponentDescription.
  947. ;*************************************************************************
  948.  
  949. ;
  950. ; pascal OSAError OSAScriptingComponentName(ComponentInstance scriptingComponent, AEDesc *resultingScriptingComponentName)
  951. ;
  952.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  953.         Macro
  954.         _OSAScriptingComponentName
  955.             move.l              #$00040102,-(sp)
  956.             moveq               #0,D0
  957.             dc.w                $A82A
  958.         EndM
  959.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  960.         IMPORT_CFM_FUNCTION OSAScriptingComponentName
  961.     ENDIF
  962.  
  963. ; 
  964. ;        OSAComponentFunctionInline(kOSASelectScriptingComponentName, 4);
  965. ;        Given a scripting component, this routine returns the name of that
  966. ;        scripting component in a type that is coercable to text (typeChar).
  967. ;        The generic scripting component returns the name of the default
  968. ;        scripting component.  This name should be sufficient to convey to the
  969. ;        user the kind of script (syntax) he is expected to write.
  970. ;    
  971. ;        Errors:
  972. ;            badComponentInstance    invalid scripting component instance
  973. ;            errOSASystemError
  974. ;    
  975.  
  976. ;
  977. ; pascal OSAError OSACompile(ComponentInstance scriptingComponent, const AEDesc *sourceData, long modeFlags, OSAID *previousAndResultingScriptID)
  978. ;
  979.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  980.         Macro
  981.         _OSACompile
  982.             move.l              #$000C0103,-(sp)
  983.             moveq               #0,D0
  984.             dc.w                $A82A
  985.         EndM
  986.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  987.         IMPORT_CFM_FUNCTION OSACompile
  988.     ENDIF
  989.  
  990. ; 
  991. ;        OSAComponentFunctionInline(kOSASelectCompile, 12);
  992. ;        Coerces input desc (possibly text) into a script's internal format.
  993. ;        Once compiled, the script is ready to run.  The modeFlags convey
  994. ;        scripting component specific information.  The previous script ID
  995. ;        (result parameter) is made to refer to the newly compiled script,
  996. ;        unless it was originally kOSANullScript.  In this case a new script
  997. ;        ID is created and used.
  998. ;    
  999. ;        Errors:
  1000. ;            badComponentInstance    invalid scripting component instance
  1001. ;            errOSASystemError
  1002. ;            errAECoercionFail:        sourceData is not compilable
  1003. ;            errOSAScriptError:        sourceData was a bad script (syntax error)
  1004. ;            errOSAInvalidID:        previousAndResultingCompiledScriptID was not
  1005. ;                                    valid on input
  1006. ;    
  1007. ;        ModeFlags:
  1008. ;            kOSAModePreventGetSource
  1009. ;            kOSAModeCompileIntoContext
  1010. ;            kOSAModeAugmentContext
  1011. ;            kOSAModeNeverInteract
  1012. ;            kOSAModeCanInteract
  1013. ;            kOSAModeAlwaysInteract
  1014. ;            kOSAModeCantSwitchLayer
  1015. ;            kOSAModeDontReconnect
  1016. ;            kOSAModeDoRecord
  1017. ;    
  1018.  
  1019. ;
  1020. ; pascal OSAError OSACopyID(ComponentInstance scriptingComponent, OSAID fromID, OSAID *toID)
  1021. ;
  1022.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1023.         Macro
  1024.         _OSACopyID
  1025.             move.l              #$00080104,-(sp)
  1026.             moveq               #0,D0
  1027.             dc.w                $A82A
  1028.         EndM
  1029.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1030.         IMPORT_CFM_FUNCTION OSACopyID
  1031.     ENDIF
  1032.  
  1033. ; 
  1034. ;        OSAComponentFunctionInline(kOSASelectCopyID, 8);
  1035. ;        If toID is a reference to kOSANullScript then it is updated to have a
  1036. ;        new scriptID value.  This call can be used to perform undo or revert
  1037. ;        operations on scripts. 
  1038. ;    
  1039. ;        Errors:
  1040. ;            badComponentInstance    invalid scripting component instance
  1041. ;            errOSASystemError
  1042. ;            errOSAInvalidID
  1043. ;    
  1044.  
  1045. ; **************************************************************************
  1046. ;    OSA Optional GetSource Interface
  1047. ;**************************************************************************
  1048. ;    Scripting components that support the GetSource interface have the 
  1049. ;    kOSASupportsGetSource bit set in it's ComponentDescription.
  1050. ;*************************************************************************
  1051.  
  1052. ;
  1053. ; pascal OSAError OSAGetSource(ComponentInstance scriptingComponent, OSAID scriptID, DescType desiredType, AEDesc *resultingSourceData)
  1054. ;
  1055.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1056.         Macro
  1057.         _OSAGetSource
  1058.             move.l              #$000C0201,-(sp)
  1059.             moveq               #0,D0
  1060.             dc.w                $A82A
  1061.         EndM
  1062.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1063.         IMPORT_CFM_FUNCTION OSAGetSource
  1064.     ENDIF
  1065.  
  1066. ; 
  1067. ;        OSAComponentFunctionInline(kOSASelectGetSource, 12);
  1068. ;        This routine causes a compiled script to be output in a form (possibly
  1069. ;        text) such that it is suitable to be passed back to OSACompile.
  1070. ;
  1071. ;        Errors:
  1072. ;            badComponentInstance    invalid scripting component instance
  1073. ;            errOSASystemError
  1074. ;            errOSAInvalidID
  1075. ;            errOSASourceNotAvailable    can't get source for this scriptID
  1076. ;    
  1077.  
  1078. ; **************************************************************************
  1079. ;    OSA Optional AECoercion Interface
  1080. ;**************************************************************************
  1081. ;    Scripting components that support the AECoercion interface have the 
  1082. ;    kOSASupportsAECoercion bit set in it's ComponentDescription.
  1083. ;*************************************************************************
  1084.  
  1085. ;
  1086. ; pascal OSAError OSACoerceFromDesc(ComponentInstance scriptingComponent, const AEDesc *scriptData, long modeFlags, OSAID *resultingScriptID)
  1087. ;
  1088.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1089.         Macro
  1090.         _OSACoerceFromDesc
  1091.             move.l              #$000C0301,-(sp)
  1092.             moveq               #0,D0
  1093.             dc.w                $A82A
  1094.         EndM
  1095.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1096.         IMPORT_CFM_FUNCTION OSACoerceFromDesc
  1097.     ENDIF
  1098.  
  1099. ; 
  1100. ;        OSAComponentFunctionInline(kOSASelectCoerceFromDesc, 12);
  1101. ;        This routine causes script data to be coerced into a script value.
  1102. ;        If the scriptData is an AppleEvent, then the resultingScriptID is a
  1103. ;        compiled script ID (mode flags for OSACompile may be used in this case).
  1104. ;        Other scriptData descriptors create script value IDs.
  1105. ;    
  1106. ;        Errors:
  1107. ;            badComponentInstance    invalid scripting component instance
  1108. ;            errOSASystemError
  1109. ;    
  1110. ;        ModeFlags:
  1111. ;            kOSAModePreventGetSource
  1112. ;            kOSAModeCompileIntoContext
  1113. ;            kOSAModeNeverInteract
  1114. ;            kOSAModeCanInteract
  1115. ;            kOSAModeAlwaysInteract
  1116. ;            kOSAModeCantSwitchLayer
  1117. ;            kOSAModeDontReconnect
  1118. ;            kOSAModeDoRecord
  1119. ;    
  1120.  
  1121. ;
  1122. ; pascal OSAError OSACoerceToDesc(ComponentInstance scriptingComponent, OSAID scriptID, DescType desiredType, long modeFlags, AEDesc *result)
  1123. ;
  1124.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1125.         Macro
  1126.         _OSACoerceToDesc
  1127.             move.l              #$00100302,-(sp)
  1128.             moveq               #0,D0
  1129.             dc.w                $A82A
  1130.         EndM
  1131.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1132.         IMPORT_CFM_FUNCTION OSACoerceToDesc
  1133.     ENDIF
  1134.  
  1135. ; 
  1136. ;        OSAComponentFunctionInline(kOSASelectCoerceToDesc, 16);
  1137. ;        This routine causes a script value to be coerced into any desired form.
  1138. ;        If the scriptID denotes a compiled script, then it may be coerced to 
  1139. ;        typeAppleEvent.
  1140. ;    
  1141. ;        Errors:
  1142. ;            badComponentInstance    invalid scripting component instance
  1143. ;            errOSASystemError
  1144. ;            errOSAInvalidID
  1145. ;    
  1146.  
  1147. ; **************************************************************************
  1148. ;    OSA Optional AESending Interface
  1149. ;**************************************************************************
  1150. ;    Scripting components that support the AESending interface have the 
  1151. ;    kOSASupportsAESending bit set in it's ComponentDescription.
  1152. ;*************************************************************************
  1153.  
  1154. ; 
  1155. ;    Scripting systems will supply default values for these procedures if they
  1156. ;    are not set by the client:
  1157. ;
  1158.  
  1159. ;
  1160. ; pascal OSAError OSASetSendProc(ComponentInstance scriptingComponent, OSASendUPP sendProc, long refCon)
  1161. ;
  1162.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1163.         Macro
  1164.         _OSASetSendProc
  1165.             move.l              #$00080401,-(sp)
  1166.             moveq               #0,D0
  1167.             dc.w                $A82A
  1168.         EndM
  1169.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1170.         IMPORT_CFM_FUNCTION OSASetSendProc
  1171.     ENDIF
  1172.  
  1173. ; 
  1174. ;        OSAComponentFunctionInline(kOSASelectSetSendProc, 8);
  1175. ;        If sendProc is nil, the default sendProc is used.
  1176. ;    
  1177. ;        Errors:
  1178. ;            badComponentInstance    invalid scripting component instance
  1179. ;            errOSASystemError
  1180. ;    
  1181.  
  1182. ;
  1183. ; pascal OSAError OSAGetSendProc(ComponentInstance scriptingComponent, OSASendUPP *sendProc, long *refCon)
  1184. ;
  1185.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1186.         Macro
  1187.         _OSAGetSendProc
  1188.             move.l              #$00080402,-(sp)
  1189.             moveq               #0,D0
  1190.             dc.w                $A82A
  1191.         EndM
  1192.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1193.         IMPORT_CFM_FUNCTION OSAGetSendProc
  1194.     ENDIF
  1195.  
  1196. ; 
  1197. ;        OSAComponentFunctionInline(kOSASelectGetSendProc, 8);
  1198. ;    
  1199. ;        Errors:
  1200. ;            badComponentInstance    invalid scripting component instance
  1201. ;            errOSASystemError
  1202. ;    
  1203.  
  1204. ;
  1205. ; pascal OSAError OSASetCreateProc(ComponentInstance scriptingComponent, OSACreateAppleEventUPP createProc, long refCon)
  1206. ;
  1207.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1208.         Macro
  1209.         _OSASetCreateProc
  1210.             move.l              #$00080403,-(sp)
  1211.             moveq               #0,D0
  1212.             dc.w                $A82A
  1213.         EndM
  1214.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1215.         IMPORT_CFM_FUNCTION OSASetCreateProc
  1216.     ENDIF
  1217.  
  1218. ; 
  1219. ;        OSAComponentFunctionInline(kOSASelectSetCreateProc, 8);
  1220. ;        If createProc is nil, the default createProc is used.
  1221. ;    
  1222. ;        Errors:
  1223. ;            badComponentInstance    invalid scripting component instance
  1224. ;            errOSASystemError
  1225. ;    
  1226.  
  1227. ;
  1228. ; pascal OSAError OSAGetCreateProc(ComponentInstance scriptingComponent, OSACreateAppleEventUPP *createProc, long *refCon)
  1229. ;
  1230.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1231.         Macro
  1232.         _OSAGetCreateProc
  1233.             move.l              #$00080404,-(sp)
  1234.             moveq               #0,D0
  1235.             dc.w                $A82A
  1236.         EndM
  1237.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1238.         IMPORT_CFM_FUNCTION OSAGetCreateProc
  1239.     ENDIF
  1240.  
  1241. ; 
  1242. ;        OSAComponentFunctionInline(kOSASelectGetCreateProc, 8);
  1243. ;    
  1244. ;        Errors:
  1245. ;            badComponentInstance    invalid scripting component instance
  1246. ;            errOSASystemError
  1247. ;    
  1248.  
  1249. ;
  1250. ; pascal OSAError OSASetDefaultTarget(ComponentInstance scriptingComponent, const AEAddressDesc *target)
  1251. ;
  1252.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1253.         Macro
  1254.         _OSASetDefaultTarget
  1255.             move.l              #$00040405,-(sp)
  1256.             moveq               #0,D0
  1257.             dc.w                $A82A
  1258.         EndM
  1259.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1260.         IMPORT_CFM_FUNCTION OSASetDefaultTarget
  1261.     ENDIF
  1262.  
  1263. ; 
  1264. ;        OSAComponentFunctionInline(kOSASelectSetDefaultTarget, 4);
  1265. ;        This routine sets the default target application for AE sending.
  1266. ;        It also establishes the default target from which terminologies come.
  1267. ;        It is effectively like having an AppleScript "tell" statement around
  1268. ;        the entire program.  If this routine is not called, or if the target 
  1269. ;        is a null AEDesc, then the current application is the default target.
  1270. ;    
  1271. ;        Errors:
  1272. ;            badComponentInstance    invalid scripting component instance
  1273. ;            errOSASystemError
  1274. ;    
  1275.  
  1276. ; **************************************************************************
  1277. ;    OSA Optional Recording Interface
  1278. ;**************************************************************************
  1279. ;    Scripting components that support the Recording interface have the 
  1280. ;    kOSASupportsRecording bit set in it's ComponentDescription.
  1281. ;*************************************************************************
  1282.  
  1283. ;
  1284. ; pascal OSAError OSAStartRecording(ComponentInstance scriptingComponent, OSAID *compiledScriptToModifyID)
  1285. ;
  1286.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1287.         Macro
  1288.         _OSAStartRecording
  1289.             move.l              #$00040501,-(sp)
  1290.             moveq               #0,D0
  1291.             dc.w                $A82A
  1292.         EndM
  1293.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1294.         IMPORT_CFM_FUNCTION OSAStartRecording
  1295.     ENDIF
  1296.  
  1297. ; 
  1298. ;        OSAComponentFunctionInline(kOSASelectStartRecording, 4);
  1299. ;        Starts recording.  If compiledScriptToModifyID is kOSANullScript, a
  1300. ;        new script ID is created and returned.  If the current application has
  1301. ;        a handler for the kOSARecordedText event, then kOSARecordedText events
  1302. ;        are sent to the application containing the text of each AppleEvent 
  1303. ;        recorded.
  1304. ;    
  1305. ;        Errors:
  1306. ;            badComponentInstance    invalid scripting component instance
  1307. ;            errOSASystemError
  1308. ;            errOSAInvalidID
  1309. ;            errOSARecordingIsAlreadyOn
  1310. ;    
  1311.  
  1312. ;
  1313. ; pascal OSAError OSAStopRecording(ComponentInstance scriptingComponent, OSAID compiledScriptID)
  1314. ;
  1315.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1316.         Macro
  1317.         _OSAStopRecording
  1318.             move.l              #$00040502,-(sp)
  1319.             moveq               #0,D0
  1320.             dc.w                $A82A
  1321.         EndM
  1322.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1323.         IMPORT_CFM_FUNCTION OSAStopRecording
  1324.     ENDIF
  1325.  
  1326. ; 
  1327. ;        OSAComponentFunctionInline(kOSASelectStopRecording, 4);
  1328. ;        If compiledScriptID is not being recorded into or recording is not
  1329. ;        currently on, no error is returned.
  1330. ;    
  1331. ;        Errors:
  1332. ;            badComponentInstance    invalid scripting component instance
  1333. ;            errOSASystemError
  1334. ;            errOSAInvalidID
  1335. ;    
  1336.  
  1337. ; **************************************************************************
  1338. ;    OSA Optional Convenience Interface
  1339. ;**************************************************************************
  1340. ;    Scripting components that support the Convenience interface have the 
  1341. ;    kOSASupportsConvenience bit set in it's ComponentDescription.
  1342. ;*************************************************************************
  1343.  
  1344. ;
  1345. ; pascal OSAError OSALoadExecute(ComponentInstance scriptingComponent, const AEDesc *scriptData, OSAID contextID, long modeFlags, OSAID *resultingScriptValueID)
  1346. ;
  1347.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1348.         Macro
  1349.         _OSALoadExecute
  1350.             move.l              #$00100601,-(sp)
  1351.             moveq               #0,D0
  1352.             dc.w                $A82A
  1353.         EndM
  1354.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1355.         IMPORT_CFM_FUNCTION OSALoadExecute
  1356.     ENDIF
  1357.  
  1358. ; 
  1359. ;        OSAComponentFunctionInline(kOSASelectLoadExecute, 16);
  1360. ;        This routine is effectively equivalent to calling OSALoad followed by
  1361. ;        OSAExecute.  After execution, the compiled source is disposed.  Only the
  1362. ;        resulting value ID is retained.
  1363. ;    
  1364. ;        Errors:
  1365. ;            badComponentInstance        invalid scripting component instance
  1366. ;            errOSASystemError
  1367. ;            errOSABadStorageType:        scriptData not for this scripting component
  1368. ;            errOSACorruptData:            data seems to be corrupt
  1369. ;            errOSADataFormatObsolete    script data format is no longer supported
  1370. ;            errOSADataFormatTooNew        script data format is from a newer version
  1371. ;            errOSAInvalidID
  1372. ;            errOSAScriptError:            the executing script got an error
  1373. ;    
  1374. ;        ModeFlags:
  1375. ;            kOSAModeNeverInteract
  1376. ;            kOSAModeCanInteract
  1377. ;            kOSAModeAlwaysInteract
  1378. ;            kOSAModeCantSwitchLayer
  1379. ;            kOSAModeDontReconnect
  1380. ;            kOSAModeDoRecord
  1381. ;    
  1382.  
  1383. ;
  1384. ; pascal OSAError OSACompileExecute(ComponentInstance scriptingComponent, const AEDesc *sourceData, OSAID contextID, long modeFlags, OSAID *resultingScriptValueID)
  1385. ;
  1386.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1387.         Macro
  1388.         _OSACompileExecute
  1389.             move.l              #$00100602,-(sp)
  1390.             moveq               #0,D0
  1391.             dc.w                $A82A
  1392.         EndM
  1393.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1394.         IMPORT_CFM_FUNCTION OSACompileExecute
  1395.     ENDIF
  1396.  
  1397. ; 
  1398. ;        OSAComponentFunctionInline(kOSASelectCompileExecute, 16);
  1399. ;        This routine is effectively equivalent to calling OSACompile followed by
  1400. ;        OSAExecute.  After execution, the compiled source is disposed.  Only the
  1401. ;        resulting value ID is retained.
  1402. ;    
  1403. ;        Errors:
  1404. ;            badComponentInstance    invalid scripting component instance
  1405. ;            errOSASystemError
  1406. ;            errAECoercionFail:        sourceData is not compilable
  1407. ;            errOSAScriptError:        sourceData was a bad script (syntax error)
  1408. ;            errOSAInvalidID:        previousAndResultingCompiledScriptID was not
  1409. ;                                    valid on input
  1410. ;            errOSAScriptError:        the executing script got an error
  1411. ;    
  1412. ;        ModeFlags:
  1413. ;            kOSAModeNeverInteract
  1414. ;            kOSAModeCanInteract
  1415. ;            kOSAModeAlwaysInteract
  1416. ;            kOSAModeCantSwitchLayer
  1417. ;            kOSAModeDontReconnect
  1418. ;            kOSAModeDoRecord
  1419. ;    
  1420.  
  1421. ;
  1422. ; pascal OSAError OSADoScript(ComponentInstance scriptingComponent, const AEDesc *sourceData, OSAID contextID, DescType desiredType, long modeFlags, AEDesc *resultingText)
  1423. ;
  1424.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1425.         Macro
  1426.         _OSADoScript
  1427.             move.l              #$00140603,-(sp)
  1428.             moveq               #0,D0
  1429.             dc.w                $A82A
  1430.         EndM
  1431.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1432.         IMPORT_CFM_FUNCTION OSADoScript
  1433.     ENDIF
  1434.  
  1435. ; 
  1436. ;        OSAComponentFunctionInline(kOSASelectDoScript, 20);
  1437. ;        This routine is effectively equivalent to calling OSACompile followed by
  1438. ;        OSAExecute and then OSADisplay.  After execution, the compiled source
  1439. ;        and the resulting value are is disposed.  Only the resultingText
  1440. ;        descriptor is retained.  If a script error occur during processing, the 
  1441. ;        resultingText gets the error message of the error, and errOSAScriptError
  1442. ;        is returned.  OSAScriptError may still be used to extract more 
  1443. ;        information about the particular error.
  1444. ;    
  1445. ;        Errors:
  1446. ;            badComponentInstance    invalid scripting component instance
  1447. ;            errOSASystemError
  1448. ;            errAECoercionFail:        sourceData is not compilable or 
  1449. ;                                    desiredType not supported by scripting component
  1450. ;            errOSAScriptError:        sourceData was a bad script (syntax error)
  1451. ;            errOSAInvalidID:        previousAndResultingCompiledScriptID was not
  1452. ;                                    valid on input
  1453. ;            errOSAScriptError:        the executing script got an error
  1454. ;    
  1455. ;        ModeFlags:
  1456. ;            kOSAModeNeverInteract
  1457. ;            kOSAModeCanInteract
  1458. ;            kOSAModeAlwaysInteract
  1459. ;            kOSAModeCantSwitchLayer
  1460. ;            kOSAModeDontReconnect
  1461. ;            kOSAModeDoRecord
  1462. ;            kOSAModeDisplayForHumans
  1463. ;    
  1464.  
  1465. ; **************************************************************************
  1466. ;    OSA Optional Dialects Interface
  1467. ;**************************************************************************
  1468. ;    Scripting components that support the Dialects interface have the 
  1469. ;    kOSASupportsDialects bit set in it's ComponentDescription.
  1470. ;*************************************************************************
  1471.  
  1472. ; 
  1473. ;    These calls allows an scripting component that supports different dialects
  1474. ;    to dynamically switch between those dialects.  Although this interface is
  1475. ;    specified, the particular dialect codes are scripting component dependent.
  1476. ;
  1477.  
  1478. ;
  1479. ; pascal OSAError OSASetCurrentDialect(ComponentInstance scriptingComponent, short dialectCode)
  1480. ;
  1481.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1482.         Macro
  1483.         _OSASetCurrentDialect
  1484.             move.l              #$00020701,-(sp)
  1485.             moveq               #0,D0
  1486.             dc.w                $A82A
  1487.         EndM
  1488.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1489.         IMPORT_CFM_FUNCTION OSASetCurrentDialect
  1490.     ENDIF
  1491.  
  1492. ; 
  1493. ;        OSAComponentFunctionInline(kOSASelectSetCurrentDialect, 2);
  1494. ;    
  1495. ;        Errors:
  1496. ;            badComponentInstance    invalid scripting component instance
  1497. ;            errOSASystemError
  1498. ;            errOSANoSuchDialect:    invalid dialectCode
  1499. ;    
  1500.  
  1501. ;
  1502. ; pascal OSAError OSAGetCurrentDialect(ComponentInstance scriptingComponent, short *resultingDialectCode)
  1503. ;
  1504.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1505.         Macro
  1506.         _OSAGetCurrentDialect
  1507.             move.l              #$00040702,-(sp)
  1508.             moveq               #0,D0
  1509.             dc.w                $A82A
  1510.         EndM
  1511.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1512.         IMPORT_CFM_FUNCTION OSAGetCurrentDialect
  1513.     ENDIF
  1514.  
  1515. ; 
  1516. ;        OSAComponentFunctionInline(kOSASelectGetCurrentDialect, 4);
  1517. ;    
  1518. ;        Errors:
  1519. ;            badComponentInstance    invalid scripting component instance
  1520. ;            errOSASystemError
  1521. ;    
  1522.  
  1523. ;
  1524. ; pascal OSAError OSAAvailableDialects(ComponentInstance scriptingComponent, AEDesc *resultingDialectInfoList)
  1525. ;
  1526.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1527.         Macro
  1528.         _OSAAvailableDialects
  1529.             move.l              #$00040703,-(sp)
  1530.             moveq               #0,D0
  1531.             dc.w                $A82A
  1532.         EndM
  1533.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1534.         IMPORT_CFM_FUNCTION OSAAvailableDialects
  1535.     ENDIF
  1536.  
  1537. ; 
  1538. ;        OSAComponentFunctionInline(kOSASelectAvailableDialects, 4);
  1539. ;        This call return an AEList containing information about each of the
  1540. ;        currently available dialects of a scripting component.  Each item
  1541. ;        is an AERecord of typeOSADialectInfo that contains at least the fields
  1542. ;        keyOSADialectName, keyOSADialectCode, KeyOSADialectLangCode and 
  1543. ;        keyOSADialectScriptCode.
  1544. ;    
  1545. ;        Errors:
  1546. ;            badComponentInstance    invalid scripting component instance
  1547. ;            errOSASystemError
  1548. ;    
  1549.  
  1550. ;
  1551. ; pascal OSAError OSAGetDialectInfo(ComponentInstance scriptingComponent, short dialectCode, OSType selector, AEDesc *resultingDialectInfo)
  1552. ;
  1553.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1554.         Macro
  1555.         _OSAGetDialectInfo
  1556.             move.l              #$000A0704,-(sp)
  1557.             moveq               #0,D0
  1558.             dc.w                $A82A
  1559.         EndM
  1560.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1561.         IMPORT_CFM_FUNCTION OSAGetDialectInfo
  1562.     ENDIF
  1563.  
  1564. ; 
  1565. ;        OSAComponentFunctionInline(kOSASelectGetDialectInfo, 10);
  1566. ;        This call gives information about the specified dialect of a scripting
  1567. ;        component. It returns an AEDesc whose type depends on the selector 
  1568. ;        specified. Available selectors are the same as the field keys for a
  1569. ;        dialect info record. The type of AEDesc returned is the same as the 
  1570. ;        type of the field that has same key as the selector.
  1571. ;    
  1572. ;        Errors:
  1573. ;            badComponentInstance    invalid scripting component instance
  1574. ;            errOSASystemError
  1575. ;             errOSABadSelector
  1576. ;            errOSANoSuchDialect:    invalid dialectCode
  1577. ;    
  1578.  
  1579. ;
  1580. ; pascal OSAError OSAAvailableDialectCodeList(ComponentInstance scriptingComponent, AEDesc *resultingDialectCodeList)
  1581. ;
  1582.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1583.         Macro
  1584.         _OSAAvailableDialectCodeList
  1585.             move.l              #$00040705,-(sp)
  1586.             moveq               #0,D0
  1587.             dc.w                $A82A
  1588.         EndM
  1589.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1590.         IMPORT_CFM_FUNCTION OSAAvailableDialectCodeList
  1591.     ENDIF
  1592.  
  1593. ; 
  1594. ;        OSAComponentFunctionInline(kOSASelectAvailableDialectCodeList, 4);
  1595. ;        This is alternative to OSAGetAvailableDialectCodeList. Use this call
  1596. ;        and  OSAGetDialectInfo to get information on dialects.
  1597. ;        This call return an AEList containing dialect code for each of the
  1598. ;        currently available dialects of a scripting component. Each dialect
  1599. ;        code is a short integer of type typeShortInteger.
  1600. ;    
  1601. ;        Errors:
  1602. ;            badComponentInstance    invalid scripting component instance
  1603. ;            errOSASystemError
  1604. ;
  1605. ;        Type of a dialect info record containing at least keyOSADialectName
  1606. ;        and keyOSADialectCode fields.
  1607. ;
  1608. ;        keys for dialect info record, also used as selectors to OSAGetDialectInfo.
  1609. ;
  1610. ;        Field of a typeOSADialectInfo record of typeChar.
  1611. ;        Field of a typeOSADialectInfo record of typeShortInteger.
  1612. ;        Field of a typeOSADialectInfo record of typeShortInteger.
  1613. ;        Field of a typeOSADialectInfo record of typeShortInteger.
  1614. ;    
  1615.  
  1616. ; **************************************************************************
  1617. ;    OSA Optional Event Handling Interface
  1618. ;**************************************************************************
  1619. ;    Scripting components that support the Event Handling interface have the 
  1620. ;    kOSASupportsEventHandling bit set in it's ComponentDescription.
  1621. ;*************************************************************************
  1622.  
  1623. ;
  1624. ; pascal OSAError OSASetResumeDispatchProc(ComponentInstance scriptingComponent, AEEventHandlerUPP resumeDispatchProc, long refCon)
  1625. ;
  1626.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1627.         Macro
  1628.         _OSASetResumeDispatchProc
  1629.             move.l              #$00080801,-(sp)
  1630.             moveq               #0,D0
  1631.             dc.w                $A82A
  1632.         EndM
  1633.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1634.         IMPORT_CFM_FUNCTION OSASetResumeDispatchProc
  1635.     ENDIF
  1636.  
  1637. ; 
  1638. ;        OSAComponentFunctionInline(kOSASelectSetResumeDispatchProc, 8);
  1639. ;        This function is used to set the ResumeDispatchProc that will be used
  1640. ;        by OSAExecuteEvent and OSADoEvent if either no event handler can be
  1641. ;        found in the context, or the context event hander "continues" control
  1642. ;        onward. The two constants kOSAUseStandardDispatch and kOSANoDispatch
  1643. ;        may also be passed to this routine indicating that the handler registered
  1644. ;        in the application with AEInstallEventHandler should be used, or no
  1645. ;        dispatch should occur, respectively.
  1646. ;    
  1647. ;        Errors:
  1648. ;            badComponentInstance    invalid scripting component instance
  1649. ;            errOSASystemError
  1650. ;    
  1651.  
  1652.  
  1653. kOSAUseStandardDispatch            EQU        $FFFFFFFF
  1654. ; 
  1655. ;        Special ResumeDispatchProc constant which may be passed to 
  1656. ;        OSASetResumeDispatchProc indicating that the handler registered
  1657. ;        in the application with AEInstallEventHandler should be used.
  1658. ;        
  1659. ;        NOTE:    Had to remove the cast (AEEventHandlerUPP).  The C compiler
  1660. ;                doesn't allow pointer types to be assigned to an enum.  All
  1661. ;                constants must be assigned as enums to translate properly to
  1662. ;                Pascal.
  1663. ;    
  1664.  
  1665.  
  1666. kOSANoDispatch                    EQU        0
  1667. ; 
  1668. ;        Special ResumeDispatchProc constant which may be passed to 
  1669. ;        OSASetResumeDispatchProc indicating that no dispatch should occur.
  1670. ;        
  1671. ;        NOTE:    Had to remove the cast (AEEventHandlerUPP).  The C compiler
  1672. ;                doesn't allow pointer types to be assigned to an enum.  All
  1673. ;                constants must be assigned as enums to translate properly to
  1674. ;                Pascal.
  1675. ;    
  1676.  
  1677.  
  1678. kOSADontUsePhac                    EQU        $0001
  1679. ; 
  1680. ;        Special refCon constant that may be given to OSASetResumeDispatchProc
  1681. ;        only when kOSAUseStandardDispatch is used as the ResumeDispatchProc.
  1682. ;        This causes the standard dispatch to be performed, except the phac
  1683. ;        handler is not called.  This is useful during tinkerability, when
  1684. ;        the phac handler is used to lookup a context associated with an event's 
  1685. ;        direct parameter, and call OSAExecuteEvent or OSADoEvent.  Failure to
  1686. ;        bypass the phac handler would result in an infinite loop.
  1687. ;    
  1688.  
  1689. ;
  1690. ; pascal OSAError OSAGetResumeDispatchProc(ComponentInstance scriptingComponent, AEEventHandlerUPP *resumeDispatchProc, long *refCon)
  1691. ;
  1692.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1693.         Macro
  1694.         _OSAGetResumeDispatchProc
  1695.             move.l              #$00080802,-(sp)
  1696.             moveq               #0,D0
  1697.             dc.w                $A82A
  1698.         EndM
  1699.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1700.         IMPORT_CFM_FUNCTION OSAGetResumeDispatchProc
  1701.     ENDIF
  1702.  
  1703. ; 
  1704. ;        OSAComponentFunctionInline(kOSASelectGetResumeDispatchProc, 8);
  1705. ;        Returns the registered ResumeDispatchProc.  If no ResumeDispatchProc has
  1706. ;        been registered, then kOSAUseStandardDispatch (the default) is returned.
  1707. ;    
  1708. ;        Errors:
  1709. ;            badComponentInstance    invalid scripting component instance
  1710. ;            errOSASystemError
  1711. ;    
  1712.  
  1713. ;
  1714. ; pascal OSAError OSAExecuteEvent(ComponentInstance scriptingComponent, const AppleEvent *theAppleEvent, OSAID contextID, long modeFlags, OSAID *resultingScriptValueID)
  1715. ;
  1716.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1717.         Macro
  1718.         _OSAExecuteEvent
  1719.             move.l              #$00100803,-(sp)
  1720.             moveq               #0,D0
  1721.             dc.w                $A82A
  1722.         EndM
  1723.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1724.         IMPORT_CFM_FUNCTION OSAExecuteEvent
  1725.     ENDIF
  1726.  
  1727. ; 
  1728. ;        OSAComponentFunctionInline(kOSASelectExecuteEvent, 16);
  1729. ;        This call is similar to OSAExecute except the initial command to
  1730. ;        execute comes in the form of an AppleEvent.  If the contextID
  1731. ;        defines any event handlers for that event, they are used to process
  1732. ;        the event.  If no event handler can be found in the context
  1733. ;        errAEEventNotHandled is returned.  If an event handler is found and
  1734. ;        the hander "continues" control onward, the ResumeDispatchProc
  1735. ;        (registered with OSASetResumeDispatchProc, above) is called given the
  1736. ;        AppleEvent.  The result is returned as a scriptValueID.
  1737. ;    
  1738. ;        Errors:
  1739. ;            badComponentInstance    invalid scripting component instance
  1740. ;            errOSASystemError
  1741. ;            errOSAInvalidID
  1742. ;            errOSAScriptError:        the executing script got an error
  1743. ;            errAEEventNotHandled:    no handler for event in contextID
  1744. ;    
  1745. ;        ModeFlags:
  1746. ;            kOSAModeNeverInteract
  1747. ;            kOSAModeCanInteract
  1748. ;            kOSAModeAlwaysInteract
  1749. ;            kOSAModeCantSwitchLayer
  1750. ;            kOSAModeDontReconnect
  1751. ;            kOSAModeDoRecord
  1752. ;    
  1753.  
  1754. ;
  1755. ; pascal OSAError OSADoEvent(ComponentInstance scriptingComponent, const AppleEvent *theAppleEvent, OSAID contextID, long modeFlags, AppleEvent *reply)
  1756. ;
  1757.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1758.         Macro
  1759.         _OSADoEvent
  1760.             move.l              #$00100804,-(sp)
  1761.             moveq               #0,D0
  1762.             dc.w                $A82A
  1763.         EndM
  1764.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1765.         IMPORT_CFM_FUNCTION OSADoEvent
  1766.     ENDIF
  1767.  
  1768. ; 
  1769. ;        OSAComponentFunctionInline(kOSASelectDoEvent, 16);
  1770. ;        This call is similar to OSADoScript except the initial command to
  1771. ;        execute comes in the form of an AppleEvent, and the result is an 
  1772. ;        AppleEvent reply record.  If the contextID defines any event handlers
  1773. ;        for that event, they are used to process the event.  If no event handler
  1774. ;        can be found in the context errAEEventNotHandled is returned.  If an
  1775. ;        event handler is found and the hander "continues" control onward, the
  1776. ;        ResumeDispatchProc (registered with OSASetResumeDispatchProc, above) is
  1777. ;        called given the AppleEvent.  The result is returned in the form of an
  1778. ;        AppleEvent reply descriptor. If at any time the script gets an error, or
  1779. ;        if the ResumeDispatchProc returns a reply event indicating an error,
  1780. ;        then the OSADoEvent call itself returns an error reply (i.e. OSADoEvent
  1781. ;        should never return errOSAScriptError).  Any error result returned by
  1782. ;        the ResumeDispatchProc will be returned by OSADoEvent.
  1783. ;    
  1784. ;        Errors:
  1785. ;            badComponentInstance    invalid scripting component instance
  1786. ;            errOSASystemError
  1787. ;            errOSAInvalidID
  1788. ;            errAEEventNotHandled:    no handler for event in contextID
  1789. ;    
  1790. ;        ModeFlags:
  1791. ;            kOSAModeNeverInteract
  1792. ;            kOSAModeCanInteract
  1793. ;            kOSAModeAlwaysInteract
  1794. ;            kOSAModeCantSwitchLayer
  1795. ;            kOSAModeDontReconnect
  1796. ;            kOSAModeDoRecord
  1797. ;    
  1798.  
  1799. ;
  1800. ; pascal OSAError OSAMakeContext(ComponentInstance scriptingComponent, const AEDesc *contextName, OSAID parentContext, OSAID *resultingContextID)
  1801. ;
  1802.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1803.         Macro
  1804.         _OSAMakeContext
  1805.             move.l              #$000C0805,-(sp)
  1806.             moveq               #0,D0
  1807.             dc.w                $A82A
  1808.         EndM
  1809.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1810.         IMPORT_CFM_FUNCTION OSAMakeContext
  1811.     ENDIF
  1812.  
  1813. ; 
  1814. ;        OSAComponentFunctionInline(kOSASelectMakeContext, 12);
  1815. ;        Makes a new empty context which may be passed to OSAExecute or 
  1816. ;        OSAExecuteEvent.  If contextName is typeNull, an unnamed context is
  1817. ;        created. If parentContext is kOSANullScript then the resulting context
  1818. ;        does not inherit bindings from any other context.
  1819. ;    
  1820. ;        Errors:
  1821. ;            badComponentInstance    invalid scripting component instance
  1822. ;            errOSASystemError
  1823. ;            errOSAInvalidID
  1824. ;            errAECoercionFail:        contextName is invalid
  1825. ;    
  1826.  
  1827.  
  1828.     ENDIF ; __OSA__ 
  1829.  
  1830.